<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     * <a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     * <a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.lang;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import java.io.IOException;<a name="line.19"></a>
<FONT color="green">020</FONT>    import java.io.StringWriter;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.io.Writer;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.util.Locale;<a name="line.22"></a>
<FONT color="green">023</FONT>    <a name="line.23"></a>
<FONT color="green">024</FONT>    import org.apache.commons.lang.exception.NestableRuntimeException;<a name="line.24"></a>
<FONT color="green">025</FONT>    import org.apache.commons.lang.text.StrBuilder;<a name="line.25"></a>
<FONT color="green">026</FONT>    <a name="line.26"></a>
<FONT color="green">027</FONT>    /**<a name="line.27"></a>
<FONT color="green">028</FONT>     * &lt;p&gt;Escapes and unescapes &lt;code&gt;String&lt;/code&gt;s for<a name="line.28"></a>
<FONT color="green">029</FONT>     * Java, Java Script, HTML, XML, and SQL.&lt;/p&gt;<a name="line.29"></a>
<FONT color="green">030</FONT>     *<a name="line.30"></a>
<FONT color="green">031</FONT>     * &lt;p&gt;#ThreadSafe#&lt;/p&gt;<a name="line.31"></a>
<FONT color="green">032</FONT>     * @author Apache Software Foundation<a name="line.32"></a>
<FONT color="green">033</FONT>     * @author Apache Jakarta Turbine<a name="line.33"></a>
<FONT color="green">034</FONT>     * @author Purple Technology<a name="line.34"></a>
<FONT color="green">035</FONT>     * @author &lt;a href="mailto:alex@purpletech.com"&gt;Alexander Day Chaffee&lt;/a&gt;<a name="line.35"></a>
<FONT color="green">036</FONT>     * @author Antony Riley<a name="line.36"></a>
<FONT color="green">037</FONT>     * @author Helge Tesgaard<a name="line.37"></a>
<FONT color="green">038</FONT>     * @author &lt;a href="sean@boohai.com"&gt;Sean Brown&lt;/a&gt;<a name="line.38"></a>
<FONT color="green">039</FONT>     * @author &lt;a href="mailto:ggregory@seagullsw.com"&gt;Gary Gregory&lt;/a&gt;<a name="line.39"></a>
<FONT color="green">040</FONT>     * @author Phil Steitz<a name="line.40"></a>
<FONT color="green">041</FONT>     * @author Pete Gieser<a name="line.41"></a>
<FONT color="green">042</FONT>     * @since 2.0<a name="line.42"></a>
<FONT color="green">043</FONT>     * @version $Id: StringEscapeUtils.java 1057072 2011-01-10 01:55:57Z niallp $<a name="line.43"></a>
<FONT color="green">044</FONT>     */<a name="line.44"></a>
<FONT color="green">045</FONT>    public class StringEscapeUtils {<a name="line.45"></a>
<FONT color="green">046</FONT>    <a name="line.46"></a>
<FONT color="green">047</FONT>        private static final char CSV_DELIMITER = ',';<a name="line.47"></a>
<FONT color="green">048</FONT>        private static final char CSV_QUOTE = '"';<a name="line.48"></a>
<FONT color="green">049</FONT>        private static final String CSV_QUOTE_STR = String.valueOf(CSV_QUOTE);<a name="line.49"></a>
<FONT color="green">050</FONT>        private static final char[] CSV_SEARCH_CHARS = new char[] {CSV_DELIMITER, CSV_QUOTE, CharUtils.CR, CharUtils.LF};<a name="line.50"></a>
<FONT color="green">051</FONT>    <a name="line.51"></a>
<FONT color="green">052</FONT>        /**<a name="line.52"></a>
<FONT color="green">053</FONT>         * &lt;p&gt;&lt;code&gt;StringEscapeUtils&lt;/code&gt; instances should NOT be constructed in<a name="line.53"></a>
<FONT color="green">054</FONT>         * standard programming.&lt;/p&gt;<a name="line.54"></a>
<FONT color="green">055</FONT>         *<a name="line.55"></a>
<FONT color="green">056</FONT>         * &lt;p&gt;Instead, the class should be used as:<a name="line.56"></a>
<FONT color="green">057</FONT>         * &lt;pre&gt;StringEscapeUtils.escapeJava("foo");&lt;/pre&gt;&lt;/p&gt;<a name="line.57"></a>
<FONT color="green">058</FONT>         *<a name="line.58"></a>
<FONT color="green">059</FONT>         * &lt;p&gt;This constructor is public to permit tools that require a JavaBean<a name="line.59"></a>
<FONT color="green">060</FONT>         * instance to operate.&lt;/p&gt;<a name="line.60"></a>
<FONT color="green">061</FONT>         */<a name="line.61"></a>
<FONT color="green">062</FONT>        public StringEscapeUtils() {<a name="line.62"></a>
<FONT color="green">063</FONT>          super();<a name="line.63"></a>
<FONT color="green">064</FONT>        }<a name="line.64"></a>
<FONT color="green">065</FONT>    <a name="line.65"></a>
<FONT color="green">066</FONT>        // Java and JavaScript<a name="line.66"></a>
<FONT color="green">067</FONT>        //--------------------------------------------------------------------------<a name="line.67"></a>
<FONT color="green">068</FONT>        /**<a name="line.68"></a>
<FONT color="green">069</FONT>         * &lt;p&gt;Escapes the characters in a &lt;code&gt;String&lt;/code&gt; using Java String rules.&lt;/p&gt;<a name="line.69"></a>
<FONT color="green">070</FONT>         *<a name="line.70"></a>
<FONT color="green">071</FONT>         * &lt;p&gt;Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.) &lt;/p&gt;<a name="line.71"></a>
<FONT color="green">072</FONT>         *<a name="line.72"></a>
<FONT color="green">073</FONT>         * &lt;p&gt;So a tab becomes the characters &lt;code&gt;'\\'&lt;/code&gt; and<a name="line.73"></a>
<FONT color="green">074</FONT>         * &lt;code&gt;'t'&lt;/code&gt;.&lt;/p&gt;<a name="line.74"></a>
<FONT color="green">075</FONT>         *<a name="line.75"></a>
<FONT color="green">076</FONT>         * &lt;p&gt;The only difference between Java strings and JavaScript strings<a name="line.76"></a>
<FONT color="green">077</FONT>         * is that in JavaScript, a single quote must be escaped.&lt;/p&gt;<a name="line.77"></a>
<FONT color="green">078</FONT>         *<a name="line.78"></a>
<FONT color="green">079</FONT>         * &lt;p&gt;Example:<a name="line.79"></a>
<FONT color="green">080</FONT>         * &lt;pre&gt;<a name="line.80"></a>
<FONT color="green">081</FONT>         * input string: He didn't say, "Stop!"<a name="line.81"></a>
<FONT color="green">082</FONT>         * output string: He didn't say, \"Stop!\"<a name="line.82"></a>
<FONT color="green">083</FONT>         * &lt;/pre&gt;<a name="line.83"></a>
<FONT color="green">084</FONT>         * &lt;/p&gt;<a name="line.84"></a>
<FONT color="green">085</FONT>         *<a name="line.85"></a>
<FONT color="green">086</FONT>         * @param str  String to escape values in, may be null<a name="line.86"></a>
<FONT color="green">087</FONT>         * @return String with escaped values, &lt;code&gt;null&lt;/code&gt; if null string input<a name="line.87"></a>
<FONT color="green">088</FONT>         */<a name="line.88"></a>
<FONT color="green">089</FONT>        public static String escapeJava(String str) {<a name="line.89"></a>
<FONT color="green">090</FONT>            return escapeJavaStyleString(str, false, false);<a name="line.90"></a>
<FONT color="green">091</FONT>        }<a name="line.91"></a>
<FONT color="green">092</FONT>    <a name="line.92"></a>
<FONT color="green">093</FONT>        /**<a name="line.93"></a>
<FONT color="green">094</FONT>         * &lt;p&gt;Escapes the characters in a &lt;code&gt;String&lt;/code&gt; using Java String rules to<a name="line.94"></a>
<FONT color="green">095</FONT>         * a &lt;code&gt;Writer&lt;/code&gt;.&lt;/p&gt;<a name="line.95"></a>
<FONT color="green">096</FONT>         * <a name="line.96"></a>
<FONT color="green">097</FONT>         * &lt;p&gt;A &lt;code&gt;null&lt;/code&gt; string input has no effect.&lt;/p&gt;<a name="line.97"></a>
<FONT color="green">098</FONT>         * <a name="line.98"></a>
<FONT color="green">099</FONT>         * @see #escapeJava(java.lang.String)<a name="line.99"></a>
<FONT color="green">100</FONT>         * @param out  Writer to write escaped string into<a name="line.100"></a>
<FONT color="green">101</FONT>         * @param str  String to escape values in, may be null<a name="line.101"></a>
<FONT color="green">102</FONT>         * @throws IllegalArgumentException if the Writer is &lt;code&gt;null&lt;/code&gt;<a name="line.102"></a>
<FONT color="green">103</FONT>         * @throws IOException if error occurs on underlying Writer<a name="line.103"></a>
<FONT color="green">104</FONT>         */<a name="line.104"></a>
<FONT color="green">105</FONT>        public static void escapeJava(Writer out, String str) throws IOException {<a name="line.105"></a>
<FONT color="green">106</FONT>            escapeJavaStyleString(out, str, false, false);<a name="line.106"></a>
<FONT color="green">107</FONT>        }<a name="line.107"></a>
<FONT color="green">108</FONT>    <a name="line.108"></a>
<FONT color="green">109</FONT>        /**<a name="line.109"></a>
<FONT color="green">110</FONT>         * &lt;p&gt;Escapes the characters in a &lt;code&gt;String&lt;/code&gt; using JavaScript String rules.&lt;/p&gt;<a name="line.110"></a>
<FONT color="green">111</FONT>         * &lt;p&gt;Escapes any values it finds into their JavaScript String form.<a name="line.111"></a>
<FONT color="green">112</FONT>         * Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.) &lt;/p&gt;<a name="line.112"></a>
<FONT color="green">113</FONT>         *<a name="line.113"></a>
<FONT color="green">114</FONT>         * &lt;p&gt;So a tab becomes the characters &lt;code&gt;'\\'&lt;/code&gt; and<a name="line.114"></a>
<FONT color="green">115</FONT>         * &lt;code&gt;'t'&lt;/code&gt;.&lt;/p&gt;<a name="line.115"></a>
<FONT color="green">116</FONT>         *<a name="line.116"></a>
<FONT color="green">117</FONT>         * &lt;p&gt;The only difference between Java strings and JavaScript strings<a name="line.117"></a>
<FONT color="green">118</FONT>         * is that in JavaScript, a single quote must be escaped.&lt;/p&gt;<a name="line.118"></a>
<FONT color="green">119</FONT>         *<a name="line.119"></a>
<FONT color="green">120</FONT>         * &lt;p&gt;Example:<a name="line.120"></a>
<FONT color="green">121</FONT>         * &lt;pre&gt;<a name="line.121"></a>
<FONT color="green">122</FONT>         * input string: He didn't say, "Stop!"<a name="line.122"></a>
<FONT color="green">123</FONT>         * output string: He didn\'t say, \"Stop!\"<a name="line.123"></a>
<FONT color="green">124</FONT>         * &lt;/pre&gt;<a name="line.124"></a>
<FONT color="green">125</FONT>         * &lt;/p&gt;<a name="line.125"></a>
<FONT color="green">126</FONT>         *<a name="line.126"></a>
<FONT color="green">127</FONT>         * @param str  String to escape values in, may be null<a name="line.127"></a>
<FONT color="green">128</FONT>         * @return String with escaped values, &lt;code&gt;null&lt;/code&gt; if null string input<a name="line.128"></a>
<FONT color="green">129</FONT>         */<a name="line.129"></a>
<FONT color="green">130</FONT>        public static String escapeJavaScript(String str) {<a name="line.130"></a>
<FONT color="green">131</FONT>            return escapeJavaStyleString(str, true, true);<a name="line.131"></a>
<FONT color="green">132</FONT>        }<a name="line.132"></a>
<FONT color="green">133</FONT>    <a name="line.133"></a>
<FONT color="green">134</FONT>        /**<a name="line.134"></a>
<FONT color="green">135</FONT>         * &lt;p&gt;Escapes the characters in a &lt;code&gt;String&lt;/code&gt; using JavaScript String rules<a name="line.135"></a>
<FONT color="green">136</FONT>         * to a &lt;code&gt;Writer&lt;/code&gt;.&lt;/p&gt;<a name="line.136"></a>
<FONT color="green">137</FONT>         * <a name="line.137"></a>
<FONT color="green">138</FONT>         * &lt;p&gt;A &lt;code&gt;null&lt;/code&gt; string input has no effect.&lt;/p&gt;<a name="line.138"></a>
<FONT color="green">139</FONT>         * <a name="line.139"></a>
<FONT color="green">140</FONT>         * @see #escapeJavaScript(java.lang.String)<a name="line.140"></a>
<FONT color="green">141</FONT>         * @param out  Writer to write escaped string into<a name="line.141"></a>
<FONT color="green">142</FONT>         * @param str  String to escape values in, may be null<a name="line.142"></a>
<FONT color="green">143</FONT>         * @throws IllegalArgumentException if the Writer is &lt;code&gt;null&lt;/code&gt;<a name="line.143"></a>
<FONT color="green">144</FONT>         * @throws IOException if error occurs on underlying Writer<a name="line.144"></a>
<FONT color="green">145</FONT>         **/<a name="line.145"></a>
<FONT color="green">146</FONT>        public static void escapeJavaScript(Writer out, String str) throws IOException {<a name="line.146"></a>
<FONT color="green">147</FONT>            escapeJavaStyleString(out, str, true, true);<a name="line.147"></a>
<FONT color="green">148</FONT>        }<a name="line.148"></a>
<FONT color="green">149</FONT>    <a name="line.149"></a>
<FONT color="green">150</FONT>        /**<a name="line.150"></a>
<FONT color="green">151</FONT>         * &lt;p&gt;Worker method for the {@link #escapeJavaScript(String)} method.&lt;/p&gt;<a name="line.151"></a>
<FONT color="green">152</FONT>         * <a name="line.152"></a>
<FONT color="green">153</FONT>         * @param str String to escape values in, may be null<a name="line.153"></a>
<FONT color="green">154</FONT>         * @param escapeSingleQuotes escapes single quotes if &lt;code&gt;true&lt;/code&gt;<a name="line.154"></a>
<FONT color="green">155</FONT>         * @param escapeForwardSlash TODO<a name="line.155"></a>
<FONT color="green">156</FONT>         * @return the escaped string<a name="line.156"></a>
<FONT color="green">157</FONT>         */<a name="line.157"></a>
<FONT color="green">158</FONT>        private static String escapeJavaStyleString(String str, boolean escapeSingleQuotes, boolean escapeForwardSlash) {<a name="line.158"></a>
<FONT color="green">159</FONT>            if (str == null) {<a name="line.159"></a>
<FONT color="green">160</FONT>                return null;<a name="line.160"></a>
<FONT color="green">161</FONT>            }<a name="line.161"></a>
<FONT color="green">162</FONT>            try {<a name="line.162"></a>
<FONT color="green">163</FONT>                StringWriter writer = new StringWriter(str.length() * 2);<a name="line.163"></a>
<FONT color="green">164</FONT>                escapeJavaStyleString(writer, str, escapeSingleQuotes, escapeForwardSlash);<a name="line.164"></a>
<FONT color="green">165</FONT>                return writer.toString();<a name="line.165"></a>
<FONT color="green">166</FONT>            } catch (IOException ioe) {<a name="line.166"></a>
<FONT color="green">167</FONT>                // this should never ever happen while writing to a StringWriter<a name="line.167"></a>
<FONT color="green">168</FONT>                throw new UnhandledException(ioe);<a name="line.168"></a>
<FONT color="green">169</FONT>            }<a name="line.169"></a>
<FONT color="green">170</FONT>        }<a name="line.170"></a>
<FONT color="green">171</FONT>    <a name="line.171"></a>
<FONT color="green">172</FONT>        /**<a name="line.172"></a>
<FONT color="green">173</FONT>         * &lt;p&gt;Worker method for the {@link #escapeJavaScript(String)} method.&lt;/p&gt;<a name="line.173"></a>
<FONT color="green">174</FONT>         * <a name="line.174"></a>
<FONT color="green">175</FONT>         * @param out write to receieve the escaped string<a name="line.175"></a>
<FONT color="green">176</FONT>         * @param str String to escape values in, may be null<a name="line.176"></a>
<FONT color="green">177</FONT>         * @param escapeSingleQuote escapes single quotes if &lt;code&gt;true&lt;/code&gt;<a name="line.177"></a>
<FONT color="green">178</FONT>         * @param escapeForwardSlash TODO<a name="line.178"></a>
<FONT color="green">179</FONT>         * @throws IOException if an IOException occurs<a name="line.179"></a>
<FONT color="green">180</FONT>         */<a name="line.180"></a>
<FONT color="green">181</FONT>        private static void escapeJavaStyleString(Writer out, String str, boolean escapeSingleQuote,<a name="line.181"></a>
<FONT color="green">182</FONT>                boolean escapeForwardSlash) throws IOException {<a name="line.182"></a>
<FONT color="green">183</FONT>            if (out == null) {<a name="line.183"></a>
<FONT color="green">184</FONT>                throw new IllegalArgumentException("The Writer must not be null");<a name="line.184"></a>
<FONT color="green">185</FONT>            }<a name="line.185"></a>
<FONT color="green">186</FONT>            if (str == null) {<a name="line.186"></a>
<FONT color="green">187</FONT>                return;<a name="line.187"></a>
<FONT color="green">188</FONT>            }<a name="line.188"></a>
<FONT color="green">189</FONT>            int sz;<a name="line.189"></a>
<FONT color="green">190</FONT>            sz = str.length();<a name="line.190"></a>
<FONT color="green">191</FONT>            for (int i = 0; i &lt; sz; i++) {<a name="line.191"></a>
<FONT color="green">192</FONT>                char ch = str.charAt(i);<a name="line.192"></a>
<FONT color="green">193</FONT>    <a name="line.193"></a>
<FONT color="green">194</FONT>                // handle unicode<a name="line.194"></a>
<FONT color="green">195</FONT>                if (ch &gt; 0xfff) {<a name="line.195"></a>
<FONT color="green">196</FONT>                    out.write("\\u" + hex(ch));<a name="line.196"></a>
<FONT color="green">197</FONT>                } else if (ch &gt; 0xff) {<a name="line.197"></a>
<FONT color="green">198</FONT>                    out.write("\\u0" + hex(ch));<a name="line.198"></a>
<FONT color="green">199</FONT>                } else if (ch &gt; 0x7f) {<a name="line.199"></a>
<FONT color="green">200</FONT>                    out.write("\\u00" + hex(ch));<a name="line.200"></a>
<FONT color="green">201</FONT>                } else if (ch &lt; 32) {<a name="line.201"></a>
<FONT color="green">202</FONT>                    switch (ch) {<a name="line.202"></a>
<FONT color="green">203</FONT>                        case '\b' :<a name="line.203"></a>
<FONT color="green">204</FONT>                            out.write('\\');<a name="line.204"></a>
<FONT color="green">205</FONT>                            out.write('b');<a name="line.205"></a>
<FONT color="green">206</FONT>                            break;<a name="line.206"></a>
<FONT color="green">207</FONT>                        case '\n' :<a name="line.207"></a>
<FONT color="green">208</FONT>                            out.write('\\');<a name="line.208"></a>
<FONT color="green">209</FONT>                            out.write('n');<a name="line.209"></a>
<FONT color="green">210</FONT>                            break;<a name="line.210"></a>
<FONT color="green">211</FONT>                        case '\t' :<a name="line.211"></a>
<FONT color="green">212</FONT>                            out.write('\\');<a name="line.212"></a>
<FONT color="green">213</FONT>                            out.write('t');<a name="line.213"></a>
<FONT color="green">214</FONT>                            break;<a name="line.214"></a>
<FONT color="green">215</FONT>                        case '\f' :<a name="line.215"></a>
<FONT color="green">216</FONT>                            out.write('\\');<a name="line.216"></a>
<FONT color="green">217</FONT>                            out.write('f');<a name="line.217"></a>
<FONT color="green">218</FONT>                            break;<a name="line.218"></a>
<FONT color="green">219</FONT>                        case '\r' :<a name="line.219"></a>
<FONT color="green">220</FONT>                            out.write('\\');<a name="line.220"></a>
<FONT color="green">221</FONT>                            out.write('r');<a name="line.221"></a>
<FONT color="green">222</FONT>                            break;<a name="line.222"></a>
<FONT color="green">223</FONT>                        default :<a name="line.223"></a>
<FONT color="green">224</FONT>                            if (ch &gt; 0xf) {<a name="line.224"></a>
<FONT color="green">225</FONT>                                out.write("\\u00" + hex(ch));<a name="line.225"></a>
<FONT color="green">226</FONT>                            } else {<a name="line.226"></a>
<FONT color="green">227</FONT>                                out.write("\\u000" + hex(ch));<a name="line.227"></a>
<FONT color="green">228</FONT>                            }<a name="line.228"></a>
<FONT color="green">229</FONT>                            break;<a name="line.229"></a>
<FONT color="green">230</FONT>                    }<a name="line.230"></a>
<FONT color="green">231</FONT>                } else {<a name="line.231"></a>
<FONT color="green">232</FONT>                    switch (ch) {<a name="line.232"></a>
<FONT color="green">233</FONT>                        case '\'' :<a name="line.233"></a>
<FONT color="green">234</FONT>                            if (escapeSingleQuote) {<a name="line.234"></a>
<FONT color="green">235</FONT>                                out.write('\\');<a name="line.235"></a>
<FONT color="green">236</FONT>                            }<a name="line.236"></a>
<FONT color="green">237</FONT>                            out.write('\'');<a name="line.237"></a>
<FONT color="green">238</FONT>                            break;<a name="line.238"></a>
<FONT color="green">239</FONT>                        case '"' :<a name="line.239"></a>
<FONT color="green">240</FONT>                            out.write('\\');<a name="line.240"></a>
<FONT color="green">241</FONT>                            out.write('"');<a name="line.241"></a>
<FONT color="green">242</FONT>                            break;<a name="line.242"></a>
<FONT color="green">243</FONT>                        case '\\' :<a name="line.243"></a>
<FONT color="green">244</FONT>                            out.write('\\');<a name="line.244"></a>
<FONT color="green">245</FONT>                            out.write('\\');<a name="line.245"></a>
<FONT color="green">246</FONT>                            break;<a name="line.246"></a>
<FONT color="green">247</FONT>                        case '/' :<a name="line.247"></a>
<FONT color="green">248</FONT>                            if (escapeForwardSlash) {<a name="line.248"></a>
<FONT color="green">249</FONT>                                out.write('\\');<a name="line.249"></a>
<FONT color="green">250</FONT>                            }<a name="line.250"></a>
<FONT color="green">251</FONT>                            out.write('/');<a name="line.251"></a>
<FONT color="green">252</FONT>                            break;<a name="line.252"></a>
<FONT color="green">253</FONT>                        default :<a name="line.253"></a>
<FONT color="green">254</FONT>                            out.write(ch);<a name="line.254"></a>
<FONT color="green">255</FONT>                            break;<a name="line.255"></a>
<FONT color="green">256</FONT>                    }<a name="line.256"></a>
<FONT color="green">257</FONT>                }<a name="line.257"></a>
<FONT color="green">258</FONT>            }<a name="line.258"></a>
<FONT color="green">259</FONT>        }<a name="line.259"></a>
<FONT color="green">260</FONT>    <a name="line.260"></a>
<FONT color="green">261</FONT>        /**<a name="line.261"></a>
<FONT color="green">262</FONT>         * &lt;p&gt;Returns an upper case hexadecimal &lt;code&gt;String&lt;/code&gt; for the given<a name="line.262"></a>
<FONT color="green">263</FONT>         * character.&lt;/p&gt;<a name="line.263"></a>
<FONT color="green">264</FONT>         * <a name="line.264"></a>
<FONT color="green">265</FONT>         * @param ch The character to convert.<a name="line.265"></a>
<FONT color="green">266</FONT>         * @return An upper case hexadecimal &lt;code&gt;String&lt;/code&gt;<a name="line.266"></a>
<FONT color="green">267</FONT>         */<a name="line.267"></a>
<FONT color="green">268</FONT>        private static String hex(char ch) {<a name="line.268"></a>
<FONT color="green">269</FONT>            return Integer.toHexString(ch).toUpperCase(Locale.ENGLISH);<a name="line.269"></a>
<FONT color="green">270</FONT>        }<a name="line.270"></a>
<FONT color="green">271</FONT>    <a name="line.271"></a>
<FONT color="green">272</FONT>        /**<a name="line.272"></a>
<FONT color="green">273</FONT>         * &lt;p&gt;Unescapes any Java literals found in the &lt;code&gt;String&lt;/code&gt;.<a name="line.273"></a>
<FONT color="green">274</FONT>         * For example, it will turn a sequence of &lt;code&gt;'\'&lt;/code&gt; and<a name="line.274"></a>
<FONT color="green">275</FONT>         * &lt;code&gt;'n'&lt;/code&gt; into a newline character, unless the &lt;code&gt;'\'&lt;/code&gt;<a name="line.275"></a>
<FONT color="green">276</FONT>         * is preceded by another &lt;code&gt;'\'&lt;/code&gt;.&lt;/p&gt;<a name="line.276"></a>
<FONT color="green">277</FONT>         * <a name="line.277"></a>
<FONT color="green">278</FONT>         * @param str  the &lt;code&gt;String&lt;/code&gt; to unescape, may be null<a name="line.278"></a>
<FONT color="green">279</FONT>         * @return a new unescaped &lt;code&gt;String&lt;/code&gt;, &lt;code&gt;null&lt;/code&gt; if null string input<a name="line.279"></a>
<FONT color="green">280</FONT>         */<a name="line.280"></a>
<FONT color="green">281</FONT>        public static String unescapeJava(String str) {<a name="line.281"></a>
<FONT color="green">282</FONT>            if (str == null) {<a name="line.282"></a>
<FONT color="green">283</FONT>                return null;<a name="line.283"></a>
<FONT color="green">284</FONT>            }<a name="line.284"></a>
<FONT color="green">285</FONT>            try {<a name="line.285"></a>
<FONT color="green">286</FONT>                StringWriter writer = new StringWriter(str.length());<a name="line.286"></a>
<FONT color="green">287</FONT>                unescapeJava(writer, str);<a name="line.287"></a>
<FONT color="green">288</FONT>                return writer.toString();<a name="line.288"></a>
<FONT color="green">289</FONT>            } catch (IOException ioe) {<a name="line.289"></a>
<FONT color="green">290</FONT>                // this should never ever happen while writing to a StringWriter<a name="line.290"></a>
<FONT color="green">291</FONT>                throw new UnhandledException(ioe);<a name="line.291"></a>
<FONT color="green">292</FONT>            }<a name="line.292"></a>
<FONT color="green">293</FONT>        }<a name="line.293"></a>
<FONT color="green">294</FONT>    <a name="line.294"></a>
<FONT color="green">295</FONT>        /**<a name="line.295"></a>
<FONT color="green">296</FONT>         * &lt;p&gt;Unescapes any Java literals found in the &lt;code&gt;String&lt;/code&gt; to a<a name="line.296"></a>
<FONT color="green">297</FONT>         * &lt;code&gt;Writer&lt;/code&gt;.&lt;/p&gt;<a name="line.297"></a>
<FONT color="green">298</FONT>         *<a name="line.298"></a>
<FONT color="green">299</FONT>         * &lt;p&gt;For example, it will turn a sequence of &lt;code&gt;'\'&lt;/code&gt; and<a name="line.299"></a>
<FONT color="green">300</FONT>         * &lt;code&gt;'n'&lt;/code&gt; into a newline character, unless the &lt;code&gt;'\'&lt;/code&gt;<a name="line.300"></a>
<FONT color="green">301</FONT>         * is preceded by another &lt;code&gt;'\'&lt;/code&gt;.&lt;/p&gt;<a name="line.301"></a>
<FONT color="green">302</FONT>         * <a name="line.302"></a>
<FONT color="green">303</FONT>         * &lt;p&gt;A &lt;code&gt;null&lt;/code&gt; string input has no effect.&lt;/p&gt;<a name="line.303"></a>
<FONT color="green">304</FONT>         * <a name="line.304"></a>
<FONT color="green">305</FONT>         * @param out  the &lt;code&gt;Writer&lt;/code&gt; used to output unescaped characters<a name="line.305"></a>
<FONT color="green">306</FONT>         * @param str  the &lt;code&gt;String&lt;/code&gt; to unescape, may be null<a name="line.306"></a>
<FONT color="green">307</FONT>         * @throws IllegalArgumentException if the Writer is &lt;code&gt;null&lt;/code&gt;<a name="line.307"></a>
<FONT color="green">308</FONT>         * @throws IOException if error occurs on underlying Writer<a name="line.308"></a>
<FONT color="green">309</FONT>         */<a name="line.309"></a>
<FONT color="green">310</FONT>        public static void unescapeJava(Writer out, String str) throws IOException {<a name="line.310"></a>
<FONT color="green">311</FONT>            if (out == null) {<a name="line.311"></a>
<FONT color="green">312</FONT>                throw new IllegalArgumentException("The Writer must not be null");<a name="line.312"></a>
<FONT color="green">313</FONT>            }<a name="line.313"></a>
<FONT color="green">314</FONT>            if (str == null) {<a name="line.314"></a>
<FONT color="green">315</FONT>                return;<a name="line.315"></a>
<FONT color="green">316</FONT>            }<a name="line.316"></a>
<FONT color="green">317</FONT>            int sz = str.length();<a name="line.317"></a>
<FONT color="green">318</FONT>            StrBuilder unicode = new StrBuilder(4);<a name="line.318"></a>
<FONT color="green">319</FONT>            boolean hadSlash = false;<a name="line.319"></a>
<FONT color="green">320</FONT>            boolean inUnicode = false;<a name="line.320"></a>
<FONT color="green">321</FONT>            for (int i = 0; i &lt; sz; i++) {<a name="line.321"></a>
<FONT color="green">322</FONT>                char ch = str.charAt(i);<a name="line.322"></a>
<FONT color="green">323</FONT>                if (inUnicode) {<a name="line.323"></a>
<FONT color="green">324</FONT>                    // if in unicode, then we're reading unicode<a name="line.324"></a>
<FONT color="green">325</FONT>                    // values in somehow<a name="line.325"></a>
<FONT color="green">326</FONT>                    unicode.append(ch);<a name="line.326"></a>
<FONT color="green">327</FONT>                    if (unicode.length() == 4) {<a name="line.327"></a>
<FONT color="green">328</FONT>                        // unicode now contains the four hex digits<a name="line.328"></a>
<FONT color="green">329</FONT>                        // which represents our unicode character<a name="line.329"></a>
<FONT color="green">330</FONT>                        try {<a name="line.330"></a>
<FONT color="green">331</FONT>                            int value = Integer.parseInt(unicode.toString(), 16);<a name="line.331"></a>
<FONT color="green">332</FONT>                            out.write((char) value);<a name="line.332"></a>
<FONT color="green">333</FONT>                            unicode.setLength(0);<a name="line.333"></a>
<FONT color="green">334</FONT>                            inUnicode = false;<a name="line.334"></a>
<FONT color="green">335</FONT>                            hadSlash = false;<a name="line.335"></a>
<FONT color="green">336</FONT>                        } catch (NumberFormatException nfe) {<a name="line.336"></a>
<FONT color="green">337</FONT>                            throw new NestableRuntimeException("Unable to parse unicode value: " + unicode, nfe);<a name="line.337"></a>
<FONT color="green">338</FONT>                        }<a name="line.338"></a>
<FONT color="green">339</FONT>                    }<a name="line.339"></a>
<FONT color="green">340</FONT>                    continue;<a name="line.340"></a>
<FONT color="green">341</FONT>                }<a name="line.341"></a>
<FONT color="green">342</FONT>                if (hadSlash) {<a name="line.342"></a>
<FONT color="green">343</FONT>                    // handle an escaped value<a name="line.343"></a>
<FONT color="green">344</FONT>                    hadSlash = false;<a name="line.344"></a>
<FONT color="green">345</FONT>                    switch (ch) {<a name="line.345"></a>
<FONT color="green">346</FONT>                        case '\\':<a name="line.346"></a>
<FONT color="green">347</FONT>                            out.write('\\');<a name="line.347"></a>
<FONT color="green">348</FONT>                            break;<a name="line.348"></a>
<FONT color="green">349</FONT>                        case '\'':<a name="line.349"></a>
<FONT color="green">350</FONT>                            out.write('\'');<a name="line.350"></a>
<FONT color="green">351</FONT>                            break;<a name="line.351"></a>
<FONT color="green">352</FONT>                        case '\"':<a name="line.352"></a>
<FONT color="green">353</FONT>                            out.write('"');<a name="line.353"></a>
<FONT color="green">354</FONT>                            break;<a name="line.354"></a>
<FONT color="green">355</FONT>                        case 'r':<a name="line.355"></a>
<FONT color="green">356</FONT>                            out.write('\r');<a name="line.356"></a>
<FONT color="green">357</FONT>                            break;<a name="line.357"></a>
<FONT color="green">358</FONT>                        case 'f':<a name="line.358"></a>
<FONT color="green">359</FONT>                            out.write('\f');<a name="line.359"></a>
<FONT color="green">360</FONT>                            break;<a name="line.360"></a>
<FONT color="green">361</FONT>                        case 't':<a name="line.361"></a>
<FONT color="green">362</FONT>                            out.write('\t');<a name="line.362"></a>
<FONT color="green">363</FONT>                            break;<a name="line.363"></a>
<FONT color="green">364</FONT>                        case 'n':<a name="line.364"></a>
<FONT color="green">365</FONT>                            out.write('\n');<a name="line.365"></a>
<FONT color="green">366</FONT>                            break;<a name="line.366"></a>
<FONT color="green">367</FONT>                        case 'b':<a name="line.367"></a>
<FONT color="green">368</FONT>                            out.write('\b');<a name="line.368"></a>
<FONT color="green">369</FONT>                            break;<a name="line.369"></a>
<FONT color="green">370</FONT>                        case 'u':<a name="line.370"></a>
<FONT color="green">371</FONT>                            {<a name="line.371"></a>
<FONT color="green">372</FONT>                                // uh-oh, we're in unicode country....<a name="line.372"></a>
<FONT color="green">373</FONT>                                inUnicode = true;<a name="line.373"></a>
<FONT color="green">374</FONT>                                break;<a name="line.374"></a>
<FONT color="green">375</FONT>                            }<a name="line.375"></a>
<FONT color="green">376</FONT>                        default :<a name="line.376"></a>
<FONT color="green">377</FONT>                            out.write(ch);<a name="line.377"></a>
<FONT color="green">378</FONT>                            break;<a name="line.378"></a>
<FONT color="green">379</FONT>                    }<a name="line.379"></a>
<FONT color="green">380</FONT>                    continue;<a name="line.380"></a>
<FONT color="green">381</FONT>                } else if (ch == '\\') {<a name="line.381"></a>
<FONT color="green">382</FONT>                    hadSlash = true;<a name="line.382"></a>
<FONT color="green">383</FONT>                    continue;<a name="line.383"></a>
<FONT color="green">384</FONT>                }<a name="line.384"></a>
<FONT color="green">385</FONT>                out.write(ch);<a name="line.385"></a>
<FONT color="green">386</FONT>            }<a name="line.386"></a>
<FONT color="green">387</FONT>            if (hadSlash) {<a name="line.387"></a>
<FONT color="green">388</FONT>                // then we're in the weird case of a \ at the end of the<a name="line.388"></a>
<FONT color="green">389</FONT>                // string, let's output it anyway.<a name="line.389"></a>
<FONT color="green">390</FONT>                out.write('\\');<a name="line.390"></a>
<FONT color="green">391</FONT>            }<a name="line.391"></a>
<FONT color="green">392</FONT>        }<a name="line.392"></a>
<FONT color="green">393</FONT>    <a name="line.393"></a>
<FONT color="green">394</FONT>        /**<a name="line.394"></a>
<FONT color="green">395</FONT>         * &lt;p&gt;Unescapes any JavaScript literals found in the &lt;code&gt;String&lt;/code&gt;.&lt;/p&gt;<a name="line.395"></a>
<FONT color="green">396</FONT>         *<a name="line.396"></a>
<FONT color="green">397</FONT>         * &lt;p&gt;For example, it will turn a sequence of &lt;code&gt;'\'&lt;/code&gt; and &lt;code&gt;'n'&lt;/code&gt;<a name="line.397"></a>
<FONT color="green">398</FONT>         * into a newline character, unless the &lt;code&gt;'\'&lt;/code&gt; is preceded by another<a name="line.398"></a>
<FONT color="green">399</FONT>         * &lt;code&gt;'\'&lt;/code&gt;.&lt;/p&gt;<a name="line.399"></a>
<FONT color="green">400</FONT>         *<a name="line.400"></a>
<FONT color="green">401</FONT>         * @see #unescapeJava(String)<a name="line.401"></a>
<FONT color="green">402</FONT>         * @param str  the &lt;code&gt;String&lt;/code&gt; to unescape, may be null<a name="line.402"></a>
<FONT color="green">403</FONT>         * @return A new unescaped &lt;code&gt;String&lt;/code&gt;, &lt;code&gt;null&lt;/code&gt; if null string input<a name="line.403"></a>
<FONT color="green">404</FONT>         */<a name="line.404"></a>
<FONT color="green">405</FONT>        public static String unescapeJavaScript(String str) {<a name="line.405"></a>
<FONT color="green">406</FONT>            return unescapeJava(str);<a name="line.406"></a>
<FONT color="green">407</FONT>        }<a name="line.407"></a>
<FONT color="green">408</FONT>    <a name="line.408"></a>
<FONT color="green">409</FONT>        /**<a name="line.409"></a>
<FONT color="green">410</FONT>         * &lt;p&gt;Unescapes any JavaScript literals found in the &lt;code&gt;String&lt;/code&gt; to a<a name="line.410"></a>
<FONT color="green">411</FONT>         * &lt;code&gt;Writer&lt;/code&gt;.&lt;/p&gt;<a name="line.411"></a>
<FONT color="green">412</FONT>         *<a name="line.412"></a>
<FONT color="green">413</FONT>         * &lt;p&gt;For example, it will turn a sequence of &lt;code&gt;'\'&lt;/code&gt; and &lt;code&gt;'n'&lt;/code&gt;<a name="line.413"></a>
<FONT color="green">414</FONT>         * into a newline character, unless the &lt;code&gt;'\'&lt;/code&gt; is preceded by another<a name="line.414"></a>
<FONT color="green">415</FONT>         * &lt;code&gt;'\'&lt;/code&gt;.&lt;/p&gt;<a name="line.415"></a>
<FONT color="green">416</FONT>         *<a name="line.416"></a>
<FONT color="green">417</FONT>         * &lt;p&gt;A &lt;code&gt;null&lt;/code&gt; string input has no effect.&lt;/p&gt;<a name="line.417"></a>
<FONT color="green">418</FONT>         * <a name="line.418"></a>
<FONT color="green">419</FONT>         * @see #unescapeJava(Writer,String)<a name="line.419"></a>
<FONT color="green">420</FONT>         * @param out  the &lt;code&gt;Writer&lt;/code&gt; used to output unescaped characters<a name="line.420"></a>
<FONT color="green">421</FONT>         * @param str  the &lt;code&gt;String&lt;/code&gt; to unescape, may be null<a name="line.421"></a>
<FONT color="green">422</FONT>         * @throws IllegalArgumentException if the Writer is &lt;code&gt;null&lt;/code&gt;<a name="line.422"></a>
<FONT color="green">423</FONT>         * @throws IOException if error occurs on underlying Writer<a name="line.423"></a>
<FONT color="green">424</FONT>         */<a name="line.424"></a>
<FONT color="green">425</FONT>        public static void unescapeJavaScript(Writer out, String str) throws IOException {<a name="line.425"></a>
<FONT color="green">426</FONT>            unescapeJava(out, str);<a name="line.426"></a>
<FONT color="green">427</FONT>        }<a name="line.427"></a>
<FONT color="green">428</FONT>    <a name="line.428"></a>
<FONT color="green">429</FONT>        // HTML and XML<a name="line.429"></a>
<FONT color="green">430</FONT>        //--------------------------------------------------------------------------<a name="line.430"></a>
<FONT color="green">431</FONT>        /**<a name="line.431"></a>
<FONT color="green">432</FONT>         * &lt;p&gt;Escapes the characters in a &lt;code&gt;String&lt;/code&gt; using HTML entities.&lt;/p&gt;<a name="line.432"></a>
<FONT color="green">433</FONT>         *<a name="line.433"></a>
<FONT color="green">434</FONT>         * &lt;p&gt;<a name="line.434"></a>
<FONT color="green">435</FONT>         * For example:<a name="line.435"></a>
<FONT color="green">436</FONT>         * &lt;/p&gt; <a name="line.436"></a>
<FONT color="green">437</FONT>         * &lt;p&gt;&lt;code&gt;"bread" &amp; "butter"&lt;/code&gt;&lt;/p&gt;<a name="line.437"></a>
<FONT color="green">438</FONT>         * becomes:<a name="line.438"></a>
<FONT color="green">439</FONT>         * &lt;p&gt;<a name="line.439"></a>
<FONT color="green">440</FONT>         * &lt;code&gt;&amp;amp;quot;bread&amp;amp;quot; &amp;amp;amp; &amp;amp;quot;butter&amp;amp;quot;&lt;/code&gt;.<a name="line.440"></a>
<FONT color="green">441</FONT>         * &lt;/p&gt;<a name="line.441"></a>
<FONT color="green">442</FONT>         *<a name="line.442"></a>
<FONT color="green">443</FONT>         * &lt;p&gt;Supports all known HTML 4.0 entities, including funky accents.<a name="line.443"></a>
<FONT color="green">444</FONT>         * Note that the commonly used apostrophe escape character (&amp;amp;apos;)<a name="line.444"></a>
<FONT color="green">445</FONT>         * is not a legal entity and so is not supported). &lt;/p&gt;<a name="line.445"></a>
<FONT color="green">446</FONT>         *<a name="line.446"></a>
<FONT color="green">447</FONT>         * @param str  the &lt;code&gt;String&lt;/code&gt; to escape, may be null<a name="line.447"></a>
<FONT color="green">448</FONT>         * @return a new escaped &lt;code&gt;String&lt;/code&gt;, &lt;code&gt;null&lt;/code&gt; if null string input<a name="line.448"></a>
<FONT color="green">449</FONT>         * <a name="line.449"></a>
<FONT color="green">450</FONT>         * @see #unescapeHtml(String)<a name="line.450"></a>
<FONT color="green">451</FONT>         * @see &lt;a href="http://hotwired.lycos.com/webmonkey/reference/special_characters/"&gt;ISO Entities&lt;/a&gt;<a name="line.451"></a>
<FONT color="green">452</FONT>         * @see &lt;a href="http://www.w3.org/TR/REC-html32#latin1"&gt;HTML 3.2 Character Entities for ISO Latin-1&lt;/a&gt;<a name="line.452"></a>
<FONT color="green">453</FONT>         * @see &lt;a href="http://www.w3.org/TR/REC-html40/sgml/entities.html"&gt;HTML 4.0 Character entity references&lt;/a&gt;<a name="line.453"></a>
<FONT color="green">454</FONT>         * @see &lt;a href="http://www.w3.org/TR/html401/charset.html#h-5.3"&gt;HTML 4.01 Character References&lt;/a&gt;<a name="line.454"></a>
<FONT color="green">455</FONT>         * @see &lt;a href="http://www.w3.org/TR/html401/charset.html#code-position"&gt;HTML 4.01 Code positions&lt;/a&gt;<a name="line.455"></a>
<FONT color="green">456</FONT>         */<a name="line.456"></a>
<FONT color="green">457</FONT>        public static String escapeHtml(String str) {<a name="line.457"></a>
<FONT color="green">458</FONT>            if (str == null) {<a name="line.458"></a>
<FONT color="green">459</FONT>                return null;<a name="line.459"></a>
<FONT color="green">460</FONT>            }<a name="line.460"></a>
<FONT color="green">461</FONT>            try {<a name="line.461"></a>
<FONT color="green">462</FONT>                StringWriter writer = new StringWriter ((int)(str.length() * 1.5));<a name="line.462"></a>
<FONT color="green">463</FONT>                escapeHtml(writer, str);<a name="line.463"></a>
<FONT color="green">464</FONT>                return writer.toString();<a name="line.464"></a>
<FONT color="green">465</FONT>            } catch (IOException ioe) {<a name="line.465"></a>
<FONT color="green">466</FONT>                //should be impossible<a name="line.466"></a>
<FONT color="green">467</FONT>                throw new UnhandledException(ioe);<a name="line.467"></a>
<FONT color="green">468</FONT>            }<a name="line.468"></a>
<FONT color="green">469</FONT>        }<a name="line.469"></a>
<FONT color="green">470</FONT>    <a name="line.470"></a>
<FONT color="green">471</FONT>        /**<a name="line.471"></a>
<FONT color="green">472</FONT>         * &lt;p&gt;Escapes the characters in a &lt;code&gt;String&lt;/code&gt; using HTML entities and writes<a name="line.472"></a>
<FONT color="green">473</FONT>         * them to a &lt;code&gt;Writer&lt;/code&gt;.&lt;/p&gt;<a name="line.473"></a>
<FONT color="green">474</FONT>         *<a name="line.474"></a>
<FONT color="green">475</FONT>         * &lt;p&gt;<a name="line.475"></a>
<FONT color="green">476</FONT>         * For example:<a name="line.476"></a>
<FONT color="green">477</FONT>         * &lt;/p&gt; <a name="line.477"></a>
<FONT color="green">478</FONT>         * &lt;code&gt;"bread" &amp; "butter"&lt;/code&gt;<a name="line.478"></a>
<FONT color="green">479</FONT>         * &lt;p&gt;becomes:&lt;/p&gt;<a name="line.479"></a>
<FONT color="green">480</FONT>         * &lt;code&gt;&amp;amp;quot;bread&amp;amp;quot; &amp;amp;amp; &amp;amp;quot;butter&amp;amp;quot;&lt;/code&gt;.<a name="line.480"></a>
<FONT color="green">481</FONT>         *<a name="line.481"></a>
<FONT color="green">482</FONT>         * &lt;p&gt;Supports all known HTML 4.0 entities, including funky accents.<a name="line.482"></a>
<FONT color="green">483</FONT>         * Note that the commonly used apostrophe escape character (&amp;amp;apos;)<a name="line.483"></a>
<FONT color="green">484</FONT>         * is not a legal entity and so is not supported). &lt;/p&gt;<a name="line.484"></a>
<FONT color="green">485</FONT>         *<a name="line.485"></a>
<FONT color="green">486</FONT>         * @param writer  the writer receiving the escaped string, not null<a name="line.486"></a>
<FONT color="green">487</FONT>         * @param string  the &lt;code&gt;String&lt;/code&gt; to escape, may be null<a name="line.487"></a>
<FONT color="green">488</FONT>         * @throws IllegalArgumentException if the writer is null<a name="line.488"></a>
<FONT color="green">489</FONT>         * @throws IOException when &lt;code&gt;Writer&lt;/code&gt; passed throws the exception from<a name="line.489"></a>
<FONT color="green">490</FONT>         *                                       calls to the {@link Writer#write(int)} methods.<a name="line.490"></a>
<FONT color="green">491</FONT>         * <a name="line.491"></a>
<FONT color="green">492</FONT>         * @see #escapeHtml(String)<a name="line.492"></a>
<FONT color="green">493</FONT>         * @see #unescapeHtml(String)<a name="line.493"></a>
<FONT color="green">494</FONT>         * @see &lt;a href="http://hotwired.lycos.com/webmonkey/reference/special_characters/"&gt;ISO Entities&lt;/a&gt;<a name="line.494"></a>
<FONT color="green">495</FONT>         * @see &lt;a href="http://www.w3.org/TR/REC-html32#latin1"&gt;HTML 3.2 Character Entities for ISO Latin-1&lt;/a&gt;<a name="line.495"></a>
<FONT color="green">496</FONT>         * @see &lt;a href="http://www.w3.org/TR/REC-html40/sgml/entities.html"&gt;HTML 4.0 Character entity references&lt;/a&gt;<a name="line.496"></a>
<FONT color="green">497</FONT>         * @see &lt;a href="http://www.w3.org/TR/html401/charset.html#h-5.3"&gt;HTML 4.01 Character References&lt;/a&gt;<a name="line.497"></a>
<FONT color="green">498</FONT>         * @see &lt;a href="http://www.w3.org/TR/html401/charset.html#code-position"&gt;HTML 4.01 Code positions&lt;/a&gt;<a name="line.498"></a>
<FONT color="green">499</FONT>         */<a name="line.499"></a>
<FONT color="green">500</FONT>        public static void escapeHtml(Writer writer, String string) throws IOException {<a name="line.500"></a>
<FONT color="green">501</FONT>            if (writer == null ) {<a name="line.501"></a>
<FONT color="green">502</FONT>                throw new IllegalArgumentException ("The Writer must not be null.");<a name="line.502"></a>
<FONT color="green">503</FONT>            }<a name="line.503"></a>
<FONT color="green">504</FONT>            if (string == null) {<a name="line.504"></a>
<FONT color="green">505</FONT>                return;<a name="line.505"></a>
<FONT color="green">506</FONT>            }<a name="line.506"></a>
<FONT color="green">507</FONT>            Entities.HTML40.escape(writer, string);<a name="line.507"></a>
<FONT color="green">508</FONT>        }<a name="line.508"></a>
<FONT color="green">509</FONT>    <a name="line.509"></a>
<FONT color="green">510</FONT>        //-----------------------------------------------------------------------<a name="line.510"></a>
<FONT color="green">511</FONT>        /**<a name="line.511"></a>
<FONT color="green">512</FONT>         * &lt;p&gt;Unescapes a string containing entity escapes to a string<a name="line.512"></a>
<FONT color="green">513</FONT>         * containing the actual Unicode characters corresponding to the<a name="line.513"></a>
<FONT color="green">514</FONT>         * escapes. Supports HTML 4.0 entities.&lt;/p&gt;<a name="line.514"></a>
<FONT color="green">515</FONT>         *<a name="line.515"></a>
<FONT color="green">516</FONT>         * &lt;p&gt;For example, the string "&amp;amp;lt;Fran&amp;amp;ccedil;ais&amp;amp;gt;"<a name="line.516"></a>
<FONT color="green">517</FONT>         * will become "&amp;lt;Fran&amp;ccedil;ais&amp;gt;"&lt;/p&gt;<a name="line.517"></a>
<FONT color="green">518</FONT>         *<a name="line.518"></a>
<FONT color="green">519</FONT>         * &lt;p&gt;If an entity is unrecognized, it is left alone, and inserted<a name="line.519"></a>
<FONT color="green">520</FONT>         * verbatim into the result string. e.g. "&amp;amp;gt;&amp;amp;zzzz;x" will<a name="line.520"></a>
<FONT color="green">521</FONT>         * become "&amp;gt;&amp;amp;zzzz;x".&lt;/p&gt;<a name="line.521"></a>
<FONT color="green">522</FONT>         *<a name="line.522"></a>
<FONT color="green">523</FONT>         * @param str  the &lt;code&gt;String&lt;/code&gt; to unescape, may be null<a name="line.523"></a>
<FONT color="green">524</FONT>         * @return a new unescaped &lt;code&gt;String&lt;/code&gt;, &lt;code&gt;null&lt;/code&gt; if null string input<a name="line.524"></a>
<FONT color="green">525</FONT>         * @see #escapeHtml(Writer, String)<a name="line.525"></a>
<FONT color="green">526</FONT>         */<a name="line.526"></a>
<FONT color="green">527</FONT>        public static String unescapeHtml(String str) {<a name="line.527"></a>
<FONT color="green">528</FONT>            if (str == null) {<a name="line.528"></a>
<FONT color="green">529</FONT>                return null;<a name="line.529"></a>
<FONT color="green">530</FONT>            }<a name="line.530"></a>
<FONT color="green">531</FONT>            try {<a name="line.531"></a>
<FONT color="green">532</FONT>                StringWriter writer = new StringWriter ((int)(str.length() * 1.5));<a name="line.532"></a>
<FONT color="green">533</FONT>                unescapeHtml(writer, str);<a name="line.533"></a>
<FONT color="green">534</FONT>                return writer.toString();<a name="line.534"></a>
<FONT color="green">535</FONT>            } catch (IOException ioe) {<a name="line.535"></a>
<FONT color="green">536</FONT>                //should be impossible<a name="line.536"></a>
<FONT color="green">537</FONT>                throw new UnhandledException(ioe);<a name="line.537"></a>
<FONT color="green">538</FONT>            }<a name="line.538"></a>
<FONT color="green">539</FONT>        }<a name="line.539"></a>
<FONT color="green">540</FONT>    <a name="line.540"></a>
<FONT color="green">541</FONT>        /**<a name="line.541"></a>
<FONT color="green">542</FONT>         * &lt;p&gt;Unescapes a string containing entity escapes to a string<a name="line.542"></a>
<FONT color="green">543</FONT>         * containing the actual Unicode characters corresponding to the<a name="line.543"></a>
<FONT color="green">544</FONT>         * escapes. Supports HTML 4.0 entities.&lt;/p&gt;<a name="line.544"></a>
<FONT color="green">545</FONT>         *<a name="line.545"></a>
<FONT color="green">546</FONT>         * &lt;p&gt;For example, the string "&amp;amp;lt;Fran&amp;amp;ccedil;ais&amp;amp;gt;"<a name="line.546"></a>
<FONT color="green">547</FONT>         * will become "&amp;lt;Fran&amp;ccedil;ais&amp;gt;"&lt;/p&gt;<a name="line.547"></a>
<FONT color="green">548</FONT>         *<a name="line.548"></a>
<FONT color="green">549</FONT>         * &lt;p&gt;If an entity is unrecognized, it is left alone, and inserted<a name="line.549"></a>
<FONT color="green">550</FONT>         * verbatim into the result string. e.g. "&amp;amp;gt;&amp;amp;zzzz;x" will<a name="line.550"></a>
<FONT color="green">551</FONT>         * become "&amp;gt;&amp;amp;zzzz;x".&lt;/p&gt;<a name="line.551"></a>
<FONT color="green">552</FONT>         *<a name="line.552"></a>
<FONT color="green">553</FONT>         * @param writer  the writer receiving the unescaped string, not null<a name="line.553"></a>
<FONT color="green">554</FONT>         * @param string  the &lt;code&gt;String&lt;/code&gt; to unescape, may be null<a name="line.554"></a>
<FONT color="green">555</FONT>         * @throws IllegalArgumentException if the writer is null<a name="line.555"></a>
<FONT color="green">556</FONT>         * @throws IOException if an IOException occurs<a name="line.556"></a>
<FONT color="green">557</FONT>         * @see #escapeHtml(String)<a name="line.557"></a>
<FONT color="green">558</FONT>         */<a name="line.558"></a>
<FONT color="green">559</FONT>        public static void unescapeHtml(Writer writer, String string) throws IOException {<a name="line.559"></a>
<FONT color="green">560</FONT>            if (writer == null ) {<a name="line.560"></a>
<FONT color="green">561</FONT>                throw new IllegalArgumentException ("The Writer must not be null.");<a name="line.561"></a>
<FONT color="green">562</FONT>            }<a name="line.562"></a>
<FONT color="green">563</FONT>            if (string == null) {<a name="line.563"></a>
<FONT color="green">564</FONT>                return;<a name="line.564"></a>
<FONT color="green">565</FONT>            }<a name="line.565"></a>
<FONT color="green">566</FONT>            Entities.HTML40.unescape(writer, string);<a name="line.566"></a>
<FONT color="green">567</FONT>        }<a name="line.567"></a>
<FONT color="green">568</FONT>    <a name="line.568"></a>
<FONT color="green">569</FONT>        //-----------------------------------------------------------------------<a name="line.569"></a>
<FONT color="green">570</FONT>        /**<a name="line.570"></a>
<FONT color="green">571</FONT>         * &lt;p&gt;Escapes the characters in a &lt;code&gt;String&lt;/code&gt; using XML entities.&lt;/p&gt;<a name="line.571"></a>
<FONT color="green">572</FONT>         *<a name="line.572"></a>
<FONT color="green">573</FONT>         * &lt;p&gt;For example: &lt;tt&gt;"bread" &amp; "butter"&lt;/tt&gt; =&gt;<a name="line.573"></a>
<FONT color="green">574</FONT>         * &lt;tt&gt;&amp;amp;quot;bread&amp;amp;quot; &amp;amp;amp; &amp;amp;quot;butter&amp;amp;quot;&lt;/tt&gt;.<a name="line.574"></a>
<FONT color="green">575</FONT>         * &lt;/p&gt;<a name="line.575"></a>
<FONT color="green">576</FONT>         *<a name="line.576"></a>
<FONT color="green">577</FONT>         * &lt;p&gt;Supports only the five basic XML entities (gt, lt, quot, amp, apos).<a name="line.577"></a>
<FONT color="green">578</FONT>         * Does not support DTDs or external entities.&lt;/p&gt;<a name="line.578"></a>
<FONT color="green">579</FONT>         *<a name="line.579"></a>
<FONT color="green">580</FONT>         * &lt;p&gt;Note that unicode characters greater than 0x7f are currently escaped to <a name="line.580"></a>
<FONT color="green">581</FONT>         *    their numerical \\u equivalent. This may change in future releases. &lt;/p&gt;<a name="line.581"></a>
<FONT color="green">582</FONT>         *<a name="line.582"></a>
<FONT color="green">583</FONT>         * @param writer  the writer receiving the unescaped string, not null<a name="line.583"></a>
<FONT color="green">584</FONT>         * @param str  the &lt;code&gt;String&lt;/code&gt; to escape, may be null<a name="line.584"></a>
<FONT color="green">585</FONT>         * @throws IllegalArgumentException if the writer is null<a name="line.585"></a>
<FONT color="green">586</FONT>         * @throws IOException if there is a problem writing<a name="line.586"></a>
<FONT color="green">587</FONT>         * @see #unescapeXml(java.lang.String)<a name="line.587"></a>
<FONT color="green">588</FONT>         */<a name="line.588"></a>
<FONT color="green">589</FONT>        public static void escapeXml(Writer writer, String str) throws IOException {<a name="line.589"></a>
<FONT color="green">590</FONT>            if (writer == null ) {<a name="line.590"></a>
<FONT color="green">591</FONT>                throw new IllegalArgumentException ("The Writer must not be null.");<a name="line.591"></a>
<FONT color="green">592</FONT>            }<a name="line.592"></a>
<FONT color="green">593</FONT>            if (str == null) {<a name="line.593"></a>
<FONT color="green">594</FONT>                return;<a name="line.594"></a>
<FONT color="green">595</FONT>            }<a name="line.595"></a>
<FONT color="green">596</FONT>            Entities.XML.escape(writer, str);<a name="line.596"></a>
<FONT color="green">597</FONT>        }<a name="line.597"></a>
<FONT color="green">598</FONT>    <a name="line.598"></a>
<FONT color="green">599</FONT>        /**<a name="line.599"></a>
<FONT color="green">600</FONT>         * &lt;p&gt;Escapes the characters in a &lt;code&gt;String&lt;/code&gt; using XML entities.&lt;/p&gt;<a name="line.600"></a>
<FONT color="green">601</FONT>         *<a name="line.601"></a>
<FONT color="green">602</FONT>         * &lt;p&gt;For example: &lt;tt&gt;"bread" &amp; "butter"&lt;/tt&gt; =&gt;<a name="line.602"></a>
<FONT color="green">603</FONT>         * &lt;tt&gt;&amp;amp;quot;bread&amp;amp;quot; &amp;amp;amp; &amp;amp;quot;butter&amp;amp;quot;&lt;/tt&gt;.<a name="line.603"></a>
<FONT color="green">604</FONT>         * &lt;/p&gt;<a name="line.604"></a>
<FONT color="green">605</FONT>         *<a name="line.605"></a>
<FONT color="green">606</FONT>         * &lt;p&gt;Supports only the five basic XML entities (gt, lt, quot, amp, apos).<a name="line.606"></a>
<FONT color="green">607</FONT>         * Does not support DTDs or external entities.&lt;/p&gt;<a name="line.607"></a>
<FONT color="green">608</FONT>         *<a name="line.608"></a>
<FONT color="green">609</FONT>         * &lt;p&gt;Note that unicode characters greater than 0x7f are currently escaped to <a name="line.609"></a>
<FONT color="green">610</FONT>         *    their numerical \\u equivalent. This may change in future releases. &lt;/p&gt;<a name="line.610"></a>
<FONT color="green">611</FONT>         *<a name="line.611"></a>
<FONT color="green">612</FONT>         * @param str  the &lt;code&gt;String&lt;/code&gt; to escape, may be null<a name="line.612"></a>
<FONT color="green">613</FONT>         * @return a new escaped &lt;code&gt;String&lt;/code&gt;, &lt;code&gt;null&lt;/code&gt; if null string input<a name="line.613"></a>
<FONT color="green">614</FONT>         * @see #unescapeXml(java.lang.String)<a name="line.614"></a>
<FONT color="green">615</FONT>         */<a name="line.615"></a>
<FONT color="green">616</FONT>        public static String escapeXml(String str) {<a name="line.616"></a>
<FONT color="green">617</FONT>            if (str == null) {<a name="line.617"></a>
<FONT color="green">618</FONT>                return null;<a name="line.618"></a>
<FONT color="green">619</FONT>            }<a name="line.619"></a>
<FONT color="green">620</FONT>            return Entities.XML.escape(str);<a name="line.620"></a>
<FONT color="green">621</FONT>        }<a name="line.621"></a>
<FONT color="green">622</FONT>    <a name="line.622"></a>
<FONT color="green">623</FONT>        //-----------------------------------------------------------------------<a name="line.623"></a>
<FONT color="green">624</FONT>        /**<a name="line.624"></a>
<FONT color="green">625</FONT>         * &lt;p&gt;Unescapes a string containing XML entity escapes to a string<a name="line.625"></a>
<FONT color="green">626</FONT>         * containing the actual Unicode characters corresponding to the<a name="line.626"></a>
<FONT color="green">627</FONT>         * escapes.&lt;/p&gt;<a name="line.627"></a>
<FONT color="green">628</FONT>         *<a name="line.628"></a>
<FONT color="green">629</FONT>         * &lt;p&gt;Supports only the five basic XML entities (gt, lt, quot, amp, apos).<a name="line.629"></a>
<FONT color="green">630</FONT>         * Does not support DTDs or external entities.&lt;/p&gt;<a name="line.630"></a>
<FONT color="green">631</FONT>         *<a name="line.631"></a>
<FONT color="green">632</FONT>         * &lt;p&gt;Note that numerical \\u unicode codes are unescaped to their respective <a name="line.632"></a>
<FONT color="green">633</FONT>         *    unicode characters. This may change in future releases. &lt;/p&gt;<a name="line.633"></a>
<FONT color="green">634</FONT>         *<a name="line.634"></a>
<FONT color="green">635</FONT>         * @param writer  the writer receiving the unescaped string, not null<a name="line.635"></a>
<FONT color="green">636</FONT>         * @param str  the &lt;code&gt;String&lt;/code&gt; to unescape, may be null<a name="line.636"></a>
<FONT color="green">637</FONT>         * @throws IllegalArgumentException if the writer is null<a name="line.637"></a>
<FONT color="green">638</FONT>         * @throws IOException if there is a problem writing<a name="line.638"></a>
<FONT color="green">639</FONT>         * @see #escapeXml(String)<a name="line.639"></a>
<FONT color="green">640</FONT>         */<a name="line.640"></a>
<FONT color="green">641</FONT>        public static void unescapeXml(Writer writer, String str) throws IOException {<a name="line.641"></a>
<FONT color="green">642</FONT>            if (writer == null ) {<a name="line.642"></a>
<FONT color="green">643</FONT>                throw new IllegalArgumentException ("The Writer must not be null.");<a name="line.643"></a>
<FONT color="green">644</FONT>            }<a name="line.644"></a>
<FONT color="green">645</FONT>            if (str == null) {<a name="line.645"></a>
<FONT color="green">646</FONT>                return;<a name="line.646"></a>
<FONT color="green">647</FONT>            }<a name="line.647"></a>
<FONT color="green">648</FONT>            Entities.XML.unescape(writer, str);<a name="line.648"></a>
<FONT color="green">649</FONT>        }<a name="line.649"></a>
<FONT color="green">650</FONT>    <a name="line.650"></a>
<FONT color="green">651</FONT>        /**<a name="line.651"></a>
<FONT color="green">652</FONT>         * &lt;p&gt;Unescapes a string containing XML entity escapes to a string<a name="line.652"></a>
<FONT color="green">653</FONT>         * containing the actual Unicode characters corresponding to the<a name="line.653"></a>
<FONT color="green">654</FONT>         * escapes.&lt;/p&gt;<a name="line.654"></a>
<FONT color="green">655</FONT>         *<a name="line.655"></a>
<FONT color="green">656</FONT>         * &lt;p&gt;Supports only the five basic XML entities (gt, lt, quot, amp, apos).<a name="line.656"></a>
<FONT color="green">657</FONT>         * Does not support DTDs or external entities.&lt;/p&gt;<a name="line.657"></a>
<FONT color="green">658</FONT>         *<a name="line.658"></a>
<FONT color="green">659</FONT>         * &lt;p&gt;Note that numerical \\u unicode codes are unescaped to their respective <a name="line.659"></a>
<FONT color="green">660</FONT>         *    unicode characters. This may change in future releases. &lt;/p&gt;<a name="line.660"></a>
<FONT color="green">661</FONT>         *<a name="line.661"></a>
<FONT color="green">662</FONT>         * @param str  the &lt;code&gt;String&lt;/code&gt; to unescape, may be null<a name="line.662"></a>
<FONT color="green">663</FONT>         * @return a new unescaped &lt;code&gt;String&lt;/code&gt;, &lt;code&gt;null&lt;/code&gt; if null string input<a name="line.663"></a>
<FONT color="green">664</FONT>         * @see #escapeXml(String)<a name="line.664"></a>
<FONT color="green">665</FONT>         */<a name="line.665"></a>
<FONT color="green">666</FONT>        public static String unescapeXml(String str) {<a name="line.666"></a>
<FONT color="green">667</FONT>            if (str == null) {<a name="line.667"></a>
<FONT color="green">668</FONT>                return null;<a name="line.668"></a>
<FONT color="green">669</FONT>            }<a name="line.669"></a>
<FONT color="green">670</FONT>            return Entities.XML.unescape(str);<a name="line.670"></a>
<FONT color="green">671</FONT>        }<a name="line.671"></a>
<FONT color="green">672</FONT>    <a name="line.672"></a>
<FONT color="green">673</FONT>        //-----------------------------------------------------------------------<a name="line.673"></a>
<FONT color="green">674</FONT>        /**<a name="line.674"></a>
<FONT color="green">675</FONT>         * &lt;p&gt;Escapes the characters in a &lt;code&gt;String&lt;/code&gt; to be suitable to pass to<a name="line.675"></a>
<FONT color="green">676</FONT>         * an SQL query.&lt;/p&gt;<a name="line.676"></a>
<FONT color="green">677</FONT>         *<a name="line.677"></a>
<FONT color="green">678</FONT>         * &lt;p&gt;For example,<a name="line.678"></a>
<FONT color="green">679</FONT>         * &lt;pre&gt;statement.executeQuery("SELECT * FROM MOVIES WHERE TITLE='" + <a name="line.679"></a>
<FONT color="green">680</FONT>         *   StringEscapeUtils.escapeSql("McHale's Navy") + <a name="line.680"></a>
<FONT color="green">681</FONT>         *   "'");&lt;/pre&gt;<a name="line.681"></a>
<FONT color="green">682</FONT>         * &lt;/p&gt;<a name="line.682"></a>
<FONT color="green">683</FONT>         *<a name="line.683"></a>
<FONT color="green">684</FONT>         * &lt;p&gt;At present, this method only turns single-quotes into doubled single-quotes<a name="line.684"></a>
<FONT color="green">685</FONT>         * (&lt;code&gt;"McHale's Navy"&lt;/code&gt; =&gt; &lt;code&gt;"McHale''s Navy"&lt;/code&gt;). It does not<a name="line.685"></a>
<FONT color="green">686</FONT>         * handle the cases of percent (%) or underscore (_) for use in LIKE clauses.&lt;/p&gt;<a name="line.686"></a>
<FONT color="green">687</FONT>         *<a name="line.687"></a>
<FONT color="green">688</FONT>         * see http://www.jguru.com/faq/view.jsp?EID=8881<a name="line.688"></a>
<FONT color="green">689</FONT>         * @param str  the string to escape, may be null<a name="line.689"></a>
<FONT color="green">690</FONT>         * @return a new String, escaped for SQL, &lt;code&gt;null&lt;/code&gt; if null string input<a name="line.690"></a>
<FONT color="green">691</FONT>         */<a name="line.691"></a>
<FONT color="green">692</FONT>        public static String escapeSql(String str) {<a name="line.692"></a>
<FONT color="green">693</FONT>            if (str == null) {<a name="line.693"></a>
<FONT color="green">694</FONT>                return null;<a name="line.694"></a>
<FONT color="green">695</FONT>            }<a name="line.695"></a>
<FONT color="green">696</FONT>            return StringUtils.replace(str, "'", "''");<a name="line.696"></a>
<FONT color="green">697</FONT>        }<a name="line.697"></a>
<FONT color="green">698</FONT>    <a name="line.698"></a>
<FONT color="green">699</FONT>        //-----------------------------------------------------------------------<a name="line.699"></a>
<FONT color="green">700</FONT>    <a name="line.700"></a>
<FONT color="green">701</FONT>        /**<a name="line.701"></a>
<FONT color="green">702</FONT>         * &lt;p&gt;Returns a &lt;code&gt;String&lt;/code&gt; value for a CSV column enclosed in double quotes,<a name="line.702"></a>
<FONT color="green">703</FONT>         * if required.&lt;/p&gt;<a name="line.703"></a>
<FONT color="green">704</FONT>         *<a name="line.704"></a>
<FONT color="green">705</FONT>         * &lt;p&gt;If the value contains a comma, newline or double quote, then the<a name="line.705"></a>
<FONT color="green">706</FONT>         *    String value is returned enclosed in double quotes.&lt;/p&gt;<a name="line.706"></a>
<FONT color="green">707</FONT>         * &lt;/p&gt;<a name="line.707"></a>
<FONT color="green">708</FONT>         *<a name="line.708"></a>
<FONT color="green">709</FONT>         * &lt;p&gt;Any double quote characters in the value are escaped with another double quote.&lt;/p&gt;<a name="line.709"></a>
<FONT color="green">710</FONT>         *<a name="line.710"></a>
<FONT color="green">711</FONT>         * &lt;p&gt;If the value does not contain a comma, newline or double quote, then the<a name="line.711"></a>
<FONT color="green">712</FONT>         *    String value is returned unchanged.&lt;/p&gt;<a name="line.712"></a>
<FONT color="green">713</FONT>         * &lt;/p&gt;<a name="line.713"></a>
<FONT color="green">714</FONT>         *<a name="line.714"></a>
<FONT color="green">715</FONT>         * see &lt;a href="http://en.wikipedia.org/wiki/Comma-separated_values"&gt;Wikipedia&lt;/a&gt; and<a name="line.715"></a>
<FONT color="green">716</FONT>         * &lt;a href="http://tools.ietf.org/html/rfc4180"&gt;RFC 4180&lt;/a&gt;.<a name="line.716"></a>
<FONT color="green">717</FONT>         *<a name="line.717"></a>
<FONT color="green">718</FONT>         * @param str the input CSV column String, may be null<a name="line.718"></a>
<FONT color="green">719</FONT>         * @return the input String, enclosed in double quotes if the value contains a comma,<a name="line.719"></a>
<FONT color="green">720</FONT>         * newline or double quote, &lt;code&gt;null&lt;/code&gt; if null string input<a name="line.720"></a>
<FONT color="green">721</FONT>         * @since 2.4<a name="line.721"></a>
<FONT color="green">722</FONT>         */<a name="line.722"></a>
<FONT color="green">723</FONT>        public static String escapeCsv(String str) {<a name="line.723"></a>
<FONT color="green">724</FONT>            if (StringUtils.containsNone(str, CSV_SEARCH_CHARS)) {<a name="line.724"></a>
<FONT color="green">725</FONT>                return str;<a name="line.725"></a>
<FONT color="green">726</FONT>            }<a name="line.726"></a>
<FONT color="green">727</FONT>            try {<a name="line.727"></a>
<FONT color="green">728</FONT>                StringWriter writer = new StringWriter();<a name="line.728"></a>
<FONT color="green">729</FONT>                escapeCsv(writer, str);<a name="line.729"></a>
<FONT color="green">730</FONT>                return writer.toString();<a name="line.730"></a>
<FONT color="green">731</FONT>            } catch (IOException ioe) {<a name="line.731"></a>
<FONT color="green">732</FONT>                // this should never ever happen while writing to a StringWriter<a name="line.732"></a>
<FONT color="green">733</FONT>                throw new UnhandledException(ioe);<a name="line.733"></a>
<FONT color="green">734</FONT>            }<a name="line.734"></a>
<FONT color="green">735</FONT>        }<a name="line.735"></a>
<FONT color="green">736</FONT>    <a name="line.736"></a>
<FONT color="green">737</FONT>        /**<a name="line.737"></a>
<FONT color="green">738</FONT>         * &lt;p&gt;Writes a &lt;code&gt;String&lt;/code&gt; value for a CSV column enclosed in double quotes,<a name="line.738"></a>
<FONT color="green">739</FONT>         * if required.&lt;/p&gt;<a name="line.739"></a>
<FONT color="green">740</FONT>         *<a name="line.740"></a>
<FONT color="green">741</FONT>         * &lt;p&gt;If the value contains a comma, newline or double quote, then the<a name="line.741"></a>
<FONT color="green">742</FONT>         *    String value is written enclosed in double quotes.&lt;/p&gt;<a name="line.742"></a>
<FONT color="green">743</FONT>         * &lt;/p&gt;<a name="line.743"></a>
<FONT color="green">744</FONT>         *<a name="line.744"></a>
<FONT color="green">745</FONT>         * &lt;p&gt;Any double quote characters in the value are escaped with another double quote.&lt;/p&gt;<a name="line.745"></a>
<FONT color="green">746</FONT>         *<a name="line.746"></a>
<FONT color="green">747</FONT>         * &lt;p&gt;If the value does not contain a comma, newline or double quote, then the<a name="line.747"></a>
<FONT color="green">748</FONT>         *    String value is written unchanged (null values are ignored).&lt;/p&gt;<a name="line.748"></a>
<FONT color="green">749</FONT>         * &lt;/p&gt;<a name="line.749"></a>
<FONT color="green">750</FONT>         *<a name="line.750"></a>
<FONT color="green">751</FONT>         * see &lt;a href="http://en.wikipedia.org/wiki/Comma-separated_values"&gt;Wikipedia&lt;/a&gt; and<a name="line.751"></a>
<FONT color="green">752</FONT>         * &lt;a href="http://tools.ietf.org/html/rfc4180"&gt;RFC 4180&lt;/a&gt;.<a name="line.752"></a>
<FONT color="green">753</FONT>         *<a name="line.753"></a>
<FONT color="green">754</FONT>         * @param str the input CSV column String, may be null<a name="line.754"></a>
<FONT color="green">755</FONT>         * @param out Writer to write input string to, enclosed in double quotes if it contains<a name="line.755"></a>
<FONT color="green">756</FONT>         * a comma, newline or double quote<a name="line.756"></a>
<FONT color="green">757</FONT>         * @throws IOException if error occurs on underlying Writer<a name="line.757"></a>
<FONT color="green">758</FONT>         * @since 2.4<a name="line.758"></a>
<FONT color="green">759</FONT>         */<a name="line.759"></a>
<FONT color="green">760</FONT>        public static void escapeCsv(Writer out, String str) throws IOException {<a name="line.760"></a>
<FONT color="green">761</FONT>            if (StringUtils.containsNone(str, CSV_SEARCH_CHARS)) {<a name="line.761"></a>
<FONT color="green">762</FONT>                if (str != null) {<a name="line.762"></a>
<FONT color="green">763</FONT>                    out.write(str);<a name="line.763"></a>
<FONT color="green">764</FONT>                }<a name="line.764"></a>
<FONT color="green">765</FONT>                return;<a name="line.765"></a>
<FONT color="green">766</FONT>            }<a name="line.766"></a>
<FONT color="green">767</FONT>            out.write(CSV_QUOTE);<a name="line.767"></a>
<FONT color="green">768</FONT>            for (int i = 0; i &lt; str.length(); i++) {<a name="line.768"></a>
<FONT color="green">769</FONT>                char c = str.charAt(i);<a name="line.769"></a>
<FONT color="green">770</FONT>                if (c == CSV_QUOTE) {<a name="line.770"></a>
<FONT color="green">771</FONT>                    out.write(CSV_QUOTE); // escape double quote<a name="line.771"></a>
<FONT color="green">772</FONT>                }<a name="line.772"></a>
<FONT color="green">773</FONT>                out.write(c);<a name="line.773"></a>
<FONT color="green">774</FONT>            }<a name="line.774"></a>
<FONT color="green">775</FONT>            out.write(CSV_QUOTE);<a name="line.775"></a>
<FONT color="green">776</FONT>        }<a name="line.776"></a>
<FONT color="green">777</FONT>    <a name="line.777"></a>
<FONT color="green">778</FONT>        /**<a name="line.778"></a>
<FONT color="green">779</FONT>         * &lt;p&gt;Returns a &lt;code&gt;String&lt;/code&gt; value for an unescaped CSV column. &lt;/p&gt;<a name="line.779"></a>
<FONT color="green">780</FONT>         *<a name="line.780"></a>
<FONT color="green">781</FONT>         * &lt;p&gt;If the value is enclosed in double quotes, and contains a comma, newline <a name="line.781"></a>
<FONT color="green">782</FONT>         *    or double quote, then quotes are removed. <a name="line.782"></a>
<FONT color="green">783</FONT>         * &lt;/p&gt;<a name="line.783"></a>
<FONT color="green">784</FONT>         *<a name="line.784"></a>
<FONT color="green">785</FONT>         * &lt;p&gt;Any double quote escaped characters (a pair of double quotes) are unescaped <a name="line.785"></a>
<FONT color="green">786</FONT>         *    to just one double quote. &lt;/p&gt;<a name="line.786"></a>
<FONT color="green">787</FONT>         *<a name="line.787"></a>
<FONT color="green">788</FONT>         * &lt;p&gt;If the value is not enclosed in double quotes, or is and does not contain a <a name="line.788"></a>
<FONT color="green">789</FONT>         *    comma, newline or double quote, then the String value is returned unchanged.&lt;/p&gt;<a name="line.789"></a>
<FONT color="green">790</FONT>         * &lt;/p&gt;<a name="line.790"></a>
<FONT color="green">791</FONT>         *<a name="line.791"></a>
<FONT color="green">792</FONT>         * see &lt;a href="http://en.wikipedia.org/wiki/Comma-separated_values"&gt;Wikipedia&lt;/a&gt; and<a name="line.792"></a>
<FONT color="green">793</FONT>         * &lt;a href="http://tools.ietf.org/html/rfc4180"&gt;RFC 4180&lt;/a&gt;.<a name="line.793"></a>
<FONT color="green">794</FONT>         *<a name="line.794"></a>
<FONT color="green">795</FONT>         * @param str the input CSV column String, may be null<a name="line.795"></a>
<FONT color="green">796</FONT>         * @return the input String, with enclosing double quotes removed and embedded double <a name="line.796"></a>
<FONT color="green">797</FONT>         * quotes unescaped, &lt;code&gt;null&lt;/code&gt; if null string input<a name="line.797"></a>
<FONT color="green">798</FONT>         * @since 2.4<a name="line.798"></a>
<FONT color="green">799</FONT>         */<a name="line.799"></a>
<FONT color="green">800</FONT>        public static String unescapeCsv(String str) {<a name="line.800"></a>
<FONT color="green">801</FONT>            if (str == null) {<a name="line.801"></a>
<FONT color="green">802</FONT>                return null;<a name="line.802"></a>
<FONT color="green">803</FONT>            }<a name="line.803"></a>
<FONT color="green">804</FONT>            try {<a name="line.804"></a>
<FONT color="green">805</FONT>                StringWriter writer = new StringWriter();<a name="line.805"></a>
<FONT color="green">806</FONT>                unescapeCsv(writer, str);<a name="line.806"></a>
<FONT color="green">807</FONT>                return writer.toString();<a name="line.807"></a>
<FONT color="green">808</FONT>            } catch (IOException ioe) {<a name="line.808"></a>
<FONT color="green">809</FONT>                // this should never ever happen while writing to a StringWriter<a name="line.809"></a>
<FONT color="green">810</FONT>                throw new UnhandledException(ioe);<a name="line.810"></a>
<FONT color="green">811</FONT>            }<a name="line.811"></a>
<FONT color="green">812</FONT>        }<a name="line.812"></a>
<FONT color="green">813</FONT>    <a name="line.813"></a>
<FONT color="green">814</FONT>        /**<a name="line.814"></a>
<FONT color="green">815</FONT>         * &lt;p&gt;Returns a &lt;code&gt;String&lt;/code&gt; value for an unescaped CSV column. &lt;/p&gt;<a name="line.815"></a>
<FONT color="green">816</FONT>         *<a name="line.816"></a>
<FONT color="green">817</FONT>         * &lt;p&gt;If the value is enclosed in double quotes, and contains a comma, newline <a name="line.817"></a>
<FONT color="green">818</FONT>         *    or double quote, then quotes are removed. <a name="line.818"></a>
<FONT color="green">819</FONT>         * &lt;/p&gt;<a name="line.819"></a>
<FONT color="green">820</FONT>         *<a name="line.820"></a>
<FONT color="green">821</FONT>         * &lt;p&gt;Any double quote escaped characters (a pair of double quotes) are unescaped <a name="line.821"></a>
<FONT color="green">822</FONT>         *    to just one double quote. &lt;/p&gt;<a name="line.822"></a>
<FONT color="green">823</FONT>         *<a name="line.823"></a>
<FONT color="green">824</FONT>         * &lt;p&gt;If the value is not enclosed in double quotes, or is and does not contain a <a name="line.824"></a>
<FONT color="green">825</FONT>         *    comma, newline or double quote, then the String value is returned unchanged.&lt;/p&gt;<a name="line.825"></a>
<FONT color="green">826</FONT>         * &lt;/p&gt;<a name="line.826"></a>
<FONT color="green">827</FONT>         *<a name="line.827"></a>
<FONT color="green">828</FONT>         * see &lt;a href="http://en.wikipedia.org/wiki/Comma-separated_values"&gt;Wikipedia&lt;/a&gt; and<a name="line.828"></a>
<FONT color="green">829</FONT>         * &lt;a href="http://tools.ietf.org/html/rfc4180"&gt;RFC 4180&lt;/a&gt;.<a name="line.829"></a>
<FONT color="green">830</FONT>         *<a name="line.830"></a>
<FONT color="green">831</FONT>         * @param str the input CSV column String, may be null<a name="line.831"></a>
<FONT color="green">832</FONT>         * @param out Writer to write the input String to, with enclosing double quotes <a name="line.832"></a>
<FONT color="green">833</FONT>         * removed and embedded double quotes unescaped, &lt;code&gt;null&lt;/code&gt; if null string input<a name="line.833"></a>
<FONT color="green">834</FONT>         * @throws IOException if error occurs on underlying Writer<a name="line.834"></a>
<FONT color="green">835</FONT>         * @since 2.4<a name="line.835"></a>
<FONT color="green">836</FONT>         */<a name="line.836"></a>
<FONT color="green">837</FONT>        public static void unescapeCsv(Writer out, String str) throws IOException {<a name="line.837"></a>
<FONT color="green">838</FONT>            if (str == null) {<a name="line.838"></a>
<FONT color="green">839</FONT>                return;<a name="line.839"></a>
<FONT color="green">840</FONT>            }<a name="line.840"></a>
<FONT color="green">841</FONT>            if (str.length() &lt; 2) {<a name="line.841"></a>
<FONT color="green">842</FONT>                out.write(str);<a name="line.842"></a>
<FONT color="green">843</FONT>                return;<a name="line.843"></a>
<FONT color="green">844</FONT>            }<a name="line.844"></a>
<FONT color="green">845</FONT>            if ( str.charAt(0) != CSV_QUOTE || str.charAt(str.length() - 1) != CSV_QUOTE ) {<a name="line.845"></a>
<FONT color="green">846</FONT>                out.write(str);<a name="line.846"></a>
<FONT color="green">847</FONT>                return;<a name="line.847"></a>
<FONT color="green">848</FONT>            }<a name="line.848"></a>
<FONT color="green">849</FONT>    <a name="line.849"></a>
<FONT color="green">850</FONT>            // strip quotes<a name="line.850"></a>
<FONT color="green">851</FONT>            String quoteless = str.substring(1, str.length() - 1);<a name="line.851"></a>
<FONT color="green">852</FONT>    <a name="line.852"></a>
<FONT color="green">853</FONT>            if ( StringUtils.containsAny(quoteless, CSV_SEARCH_CHARS) ) {<a name="line.853"></a>
<FONT color="green">854</FONT>                // deal with escaped quotes; ie) ""<a name="line.854"></a>
<FONT color="green">855</FONT>                str = StringUtils.replace(quoteless, CSV_QUOTE_STR + CSV_QUOTE_STR, CSV_QUOTE_STR);<a name="line.855"></a>
<FONT color="green">856</FONT>            }<a name="line.856"></a>
<FONT color="green">857</FONT>    <a name="line.857"></a>
<FONT color="green">858</FONT>            out.write(str);<a name="line.858"></a>
<FONT color="green">859</FONT>        }<a name="line.859"></a>
<FONT color="green">860</FONT>    <a name="line.860"></a>
<FONT color="green">861</FONT>    }<a name="line.861"></a>




























































</PRE>
</BODY>
</HTML>
